package com.utils;

import java.util.HashMap;
import java.util.Map;

/**
 * 返回数据工具类，用于构建和返回统一的API响应数据格式。
 */
public class R extends HashMap<String, Object> {
	private static final long serialVersionUID = 1L;

	/**
	 * 构造方法，初始化响应数据，默认设置code为0，表示成功。
	 */
	public R() {
		put("code", 0);
	}

	/**
	 * 返回错误响应，默认错误代码为500，错误信息为"未知异常，请联系管理员"。
	 * @return 包含错误信息的R对象
	 */
	public static R error() {
		return error(500, "未知异常，请联系管理员");
	}

	/**
	 * 返回错误响应，自定义错误信息。
	 * @param msg 错误信息
	 * @return 包含错误信息的R对象
	 */
	public static R error(String msg) {
		return error(500, msg);
	}

	/**
	 * 返回错误响应，自定义错误代码和错误信息。
	 * @param code 错误代码
	 * @param msg 错误信息
	 * @return 包含错误代码和信息的R对象
	 */
	public static R error(int code, String msg) {
		R r = new R();
		r.put("code", code);
		r.put("msg", msg);
		return r;
	}

	/**
	 * 返回成功响应，并自定义成功信息。
	 * @param msg 成功信息
	 * @return 包含成功信息的R对象
	 */
	public static R ok(String msg) {
		R r = new R();
		r.put("msg", msg);
		return r;
	}

	/**
	 * 返回成功响应，并包含自定义的数据Map。
	 * @param map 自定义数据Map
	 * @return 包含自定义数据的R对象
	 */
	public static R ok(Map<String, Object> map) {
		R r = new R();
		r.putAll(map);
		return r;
	}

	/**
	 * 返回成功响应，不包含任何额外信息。
	 * @return 成功的R对象
	 */
	public static R ok() {
		return new R();
	}

	/**
	 * 向R对象中添加键值对，并返回当前对象，便于链式调用。
	 * @param key 键
	 * @param value 值
	 * @return 当前R对象
	 */
	@Override
	public R put(String key, Object value) {
		super.put(key, value);
		return this;
	}
}
